home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / shmpg320.zip / SHAMPAGE.DOC < prev    next >
Text File  |  1992-08-01  |  14KB  |  261 lines
  1.  
  2.                                                                  
  3.  This program compliments of:                      ╓┴╖           ╓┴╖
  4.                                                  / ║ ║           ║ ║ \
  5.    ╤╕           ╤╕       ╕         ╤╕╤╕╒╕       ┌─┬║┬║┬─┬─┬─┬─┬─┬║┬║┬─┐
  6.    ││           ││      │         │││││       ▀▀▀▀║▀║▀▀▀▀▀▀▀▀▀▀▀║▀║▀▀▀▀
  7.    ││ ╤╕ ╒╕ ╕ ╒ ╞╡ ╤╕ ╕ ╒╡ ╒╤ ╤╕   ╞╡╞╡╘╕          ╨ ╨           ╨ ╨
  8.    ││ │  ╒╡ │││ ││ │  │ ││ ││ ╞╛   ││││ │             FIDO 1:369/2
  9.    ╧╛ ╧  ╘╧ ╘╧╛ ╧╛ ╧  ╘ ╘╧ ╘╡ ╘╛   ╧╛╧╛╘╛          EchoNet 50:5305/2
  10.                             │                       OurNet 65:613/2
  11.      Fort Lauderdale, FL   ╘╛                        WDNet 3090.00
  12.    (305) 523-1717 *HST/DS*
  13.  
  14.  
  15.                                 SHAMpage v3.20
  16.                             (C) 1992 by Rich Waugh
  17.  
  18. Do you ALWAYS answer the page bell, even at 3am? If so, you must be a new
  19. SysOp - SHAMpage is not for you. If, on the other hand, you do occasionally
  20. disable the page function, you might enjoy this fun little door. It allows
  21. the caller to have a nice (or not-so-nice... it's totally up to you) chat
  22. with the SysOp - even when the SysOp's not around!
  23.  
  24. SHAMpage is similar to other "A.I." programs with which you may already be
  25. familiar, such as ELIZA or CHERI. There is a bit more to SHAMpage than those
  26. programs though, for example: a routine to randomly vary the speed at which
  27. each letter is "typed", a random "typo & correction" routine and built-in
  28. communication I/O routines. All the typing delays are calculated, so the
  29. typing rate initially will vary on different machines, depending on the speed
  30. of the CPU, but they were written in a manner that allows you to configure
  31. the program to type at realistic speeds on virtually any machine (see the
  32. sample configuration file below).
  33.  
  34. While "chatting", SHAMpage checks the caller's entry, each time he hits the
  35. [ENTER] key, for up to 100 "key" words which you have previously picked. If
  36. the caller's entry contains a string matching one of those key words, an
  37. appropriate response (or even the contents of an entire text file) is typed
  38. back to him. Otherwise a random response - again, your choice (see NOMATCH in
  39. SHAMPAGE.DAT) - is sent. The key words and related replies are contained in
  40. one of two plain-vanilla ASCii data files (SHAMPAGE.DAT and MIDNITE.DAT)
  41. which you are free to modify to suit your needs. The enclosed samples are
  42. well commented and should be self-explanatory. Do not be offended by the key
  43. words or replies, some of which are rather rude - please notice that the
  44. really nasty replies are sent only after a positive match with a really nasty
  45. key word the caller has entered of his own volition.
  46.  
  47. The following variables are available in your key word replies:
  48.  
  49.         *USER* - this will be replaced by the caller's first name.
  50.         *TIME* - replaced by the current time (in 12-hour format).
  51.         *FILE* [FileName] - this tells SHAMpage to type the contents of the
  52.                             file [FileName].
  53.  
  54. SHAMpage was originally conceived as a fun, humorous door and the included
  55. data file (the one I use) reflects that - it works great with 13 year-old's
  56. at 2 in the morning! However, since I released SHAMpage to the public, many
  57. SysOps have told me it is the perfect program to answer callers' questions in
  58. a serious, informative manner whenever the SysOp is not available (a use
  59. which, I must admit, never crossed my mind when I began writing the code). If
  60. that is your intention, simply edit SHAMPAGE.DAT. If you are a hobby-oriented
  61. SysOp with a sense of humor as sick as mine, the enclosed SHAMPAGE.DAT can be
  62. used with few changes; if you intend to run SHAMpage on a business-type BBS,
  63. it will need a LOT of editing! How you use SHAMpage is up to you.
  64.  
  65.  ┌──────────────────────────────────────────────────────────────────────────┐
  66.  │  CAUTION! When you modify the data file, please remember that each KEY   │
  67.  │  WORD, including NOMATCH, is limited to a maximum of ten (10) replies.   │
  68.  │  Also, be absolutely certain you match the format of the example file.   │
  69.  │  Any variation will result in unpredictable and undesirable results. I   │
  70.  │  strongly recommend you use the included MAINTAIN utility every time     │
  71.  │  you edit your data file. MAINTAIN is a quick and dirty program          │
  72.  │  (written in about 5 minutes) to check your data file for grievous       │
  73.  │  errors and, while it will catch some obvious errors in the file, it is  │
  74.  │  not intended as a replacement for your own care in editing!             │
  75.  └──────────────────────────────────────────────────────────────────────────┘
  76.  
  77. Although written with WildCat! specifically in mind, SHAMpage runs on any BBS
  78. capable of generating a standard DOOR.SYS or DORINFOx.DEF drop file. It is,
  79. in fact, currently running with WildCat!, PCBoard, QuickBBS and Remote
  80. Access. Features include support for drop to DOS, various timer functions
  81. (caller's time left, input-timer whenever remote input is expected, SysOp
  82. hot-keys to increase/decrease caller's time left), carrier detection, CTS
  83. checking and more. You can check the caller's stats while the door is in
  84. operation. SHAMpage writes a log (similar to WildCat!'s PAGED.CAP) just in
  85. case you really WEREN'T around when you had that little chat with a caller
  86. <grin> as well as a separate file (SHAMPAGE.ERR) which logs errors, should
  87. they occur.
  88.  
  89. Perhaps most importantly, SHAMpage does include a page bell to notify you
  90. when you're being paged and you actually CAN pick up the page and chat with
  91. the caller while he is in the door. One of the benefits you will discover is
  92. that SHAMpage allows you to "screen" pages much the same as people who own
  93. telephone answering machines often decide whether or not to pick up the phone
  94. only after hearing who is on the other end and what he wants. Information
  95. about the caller appears at the bottom of the local screen: name, location,
  96. connect rate and (if using DOOR.SYS) age. If you choose not to chat with the
  97. caller, let SHAMpage do it! If you do want to chat, you can take live control
  98. at any time, transparently to the caller, by hitting [F7]. When you're
  99. finished, press [F8] and SHAMpage will resume the chat or press [F10] to
  100. return the caller to the BBS. The local screen (only) indicates whenever the
  101. chat is live.
  102.  
  103. When the caller exits the door by typing G, Q, X, EXIT, BYE, QUIT or two
  104. consecutive empty lines (SHAMpage also terminates whenever it runs out of
  105. responses to any particular key word, including NOMATCH), he receives an, up
  106. to four line, exit message which explains the SysOp was unavailable and he
  107. was actually chatting with the computer (or whatever you choose to say). If
  108. he exits by dropping carrier - some people have NO sense of humor - he might
  109. not get that message <grin>, but the door notes the dropped carrier in the
  110. log and exits gracefully anyway.
  111.  
  112.                     ──────────────────────────────────────
  113.  
  114. Here's what's required to implement SHAMpage on your board:
  115.  
  116. Make a separate directory where you will run SHAMpage. Unzip all the files in
  117. the archive into this directory. Next, you must modify SHAMPAGE.CFG to
  118. reflect the correct information for your board (see below). You will also
  119. want to edit SHAMpage.DAT to replace occurrences of my name with yours and
  120. personalize some of the opening lines, key words and/or responses, etc.
  121.  
  122. EXAMPLE SHAMPAGE.CFG
  123.  
  124. DrawBridge BBS                 <── The name of your BBS
  125. Rich                           <── SysOp's first name
  126. Waugh                          <── SysOp's last name
  127. C:\Wc30\Wcwork\Node1\DOOR.SYS  <── Path to & name of DOOR.SYS (or DORINFOx.DEF)
  128. SPLIT                          <── WildCat! style split-screen chat (or FULL)
  129. SHAMPAGE.DAT                   <── Name of the Key Word Data File
  130. SHAMPAGE.LOG                   <── Name of the Log File to write
  131. 1  <────────────────────────────── Delay factor - increase this number
  132. 0  <──────────────────────────┐    to slow down the typing speed, decrease
  133. 23:00  <───── Time to turn    │    it to speed up the typing. For example,
  134. 08:00  <──┐   Page Bell OFF   │    making this factor .5 will increase the
  135.           │                   │    typing speed 100%, making it 2 will slow
  136.           └── Time to turn    │    it down 100%. Experiment with different
  137.               Page Bell ON    │    values until you get a realistic typing
  138.                               │    speed for your machine. For your
  139.   NOTE: The last two lines    │    information, SHAMpage was written and
  140.         are optional (but     │    tested on a 286/20 machine and types
  141.         must be entered in    │    just about right with this factor set at
  142.         military-style 24:00  │    one (1). (Remember, it's SUPPOSED to
  143.         format if used).      │    emulate a real human typing, at realistic
  144.                               │    human speeds.)
  145.                               │
  146.                               └─── An integer specifying the type of
  147.                                    handshake you wish to use between the CPU
  148.                                    and modem. Valid numbers are:
  149.                                              0 = NO handshake
  150.                                              1 = XON/XOFF
  151.                                              2 = CTS/RTS
  152.                                              3 = XON/XOFF and CTS/RTS
  153.                                    If you don't know what to put here, make
  154.                                    it 0 or 1. CTS/RTS is for high-speed
  155.                                    modems.
  156.  
  157. Due to the fact the remote cursor position is generated by ANSI code, if the
  158. caller has color screens turned off, SHAMpage will default to full-screen
  159. chat, not split-screen. This is not a bug. It is intended to run this way.
  160.  
  161.                     ──────────────────────────────────────
  162.  
  163. SHAMpage is run with the following syntax: SHAMpage SHAMPAGE.CFG
  164.  
  165. For a quick demonstration, SHAMpage can also be run from the command line by
  166. typing: SHAMpage SHAMpage.CFG LOCAL.
  167.  
  168. EXAMPLE MAIN1.BAT (or DOORx.BAT):
  169.  
  170. @Echo Off
  171. Cd \Doors\SHAMpage
  172. SHAMpage SHAMPAGE.CFG
  173.  
  174. This batch file will work only if you have WildCat! set to SHELL to doors.
  175. This documentation is not intended to be a tutorial on door setup. If you've
  176. never set up a door before, please refer to your BBS documentation (page 221
  177. in the WildCat! manual).
  178.  
  179.   ┌─────────────────────────────────────────────────────────────────────────┐
  180.   │                  OPTIONAL hints for WildCat! SysOps                     │
  181.   ├─────────────────────────────────────────────────────────────────────────┤
  182.   │ To make the caller believe he is really chatting with the SysOp, run    │
  183.   │ MAKEWILD. From the Main Menu Definition page, change the "Page the      │
  184.   │ SysOp" key to some letter other than P and assign it an access level of │
  185.   │ 1001 or higher, so nobody has access to it. Next, assign DOS Hook 1 or  │
  186.   │ DOS Hook 2 to key P. Then set up SHAMpage in MAINx.BAT. If you REALLY   │
  187.   │ want to fool the caller, run MKWCTEXT and change the "Preparing system  │
  188.   │ to run a door" prompt to "".                                            │
  189.   └─────────────────────────────────────────────────────────────────────────┘
  190.  
  191.  
  192.                       FILES INCLUDED IN SHAMPAGE v3.20:
  193.  
  194.     READ.ME!      - IMPORTANT!!! Update information!!!
  195.     SHAMPAGE.CFG  - Example configuration file.
  196.     SHAMPAGE.DAT  - ASCii data file containing KEY WORDS and responses.
  197.     MIDNITE.DAT   - Alternative Data file for night-time use.
  198.     SHAMPAGE.DOC  - The file you're reading now.
  199.     SHAMPAGE.EXE  - The door itself.
  200.     SHAMPAGE.LOG  - A typical excerpt from my SHAMPAGE.LOG.
  201.     MAINTAIN.DOC  - Instructions for the SHAMPAGE.DAT maintenance utility.
  202.     MAINTAIN.EXE  - SHAMPAGE.DAT maintenance utility.
  203.     SENDIT. ASC   - Example *FILE*
  204.     WHAT'S.NEW    - Documentation of changes from release to release.
  205.     DESC.SDI      - Short program description.
  206.     FILE_ID.DIZ   - Longer program description.
  207.  
  208.                     ──────────────────────────────────────
  209.  
  210. SHAMpage is distributed as Nobitchware. I'm not charging anything for it, so
  211. you are NOT entitled to bitch about it!!!
  212.  
  213. I, for one, am sick and tired of people who solicit money for the dumb little
  214. doors/utilities we all find so indespensible, so this one's a freebie. It is
  215. fully functional and contains no time bombs. I will attempt to keep the
  216. latest version always available for FREQ (high-speed only) with the magic
  217. name SHAMPAGE. Significant updates are also hatched out into DDSDOORS and the
  218. WDNet (WCDOOR) as well as uploaded to the Cathouse.
  219.  
  220. If you find SHAMpage handy, give the DrawBridge a call and thank me. Better
  221. yet, send me your own customized SHAMPAGE.DAT file. I would appreciate
  222. anyone's "serious" data file. If it's good enough, I'll include it in future
  223. releases, with full credit to the author.
  224.  
  225. If you don't find SHAMpage useful, I'll cheerfully refund double your money!
  226.  
  227.                                   Rich Waugh
  228.  
  229.                     ──────────────────────────────────────
  230.  
  231.             FREE WildCat! 3.x doors/utilities from the DrawBridge
  232.  
  233.  
  234. BobCheck - Automatically send each new caller a personal "Welcome" message
  235.            after they pass BobCat verification. Requires BobCat and Postmstr.
  236.  
  237. CheckSec - Restrict access to any door or DOS hook based on the caller's AGE
  238.            or security level.
  239.  
  240. CodeSet  - Reset users in Master Decoder door when they reach the end of the
  241.            data file.
  242.  
  243. MailChek - Check if last caller left any messages. (Don't bother with
  244.            WildMail SCAN if not.)
  245.  
  246. MailDoor - Run more than one mail door from the WildCat! Mail Hook.
  247.  
  248. PieSet   - Reset Piesplat door players automatically when somebody wins the
  249.            game.
  250.  
  251. QwkQuote - OLX compatable reply quote maker.
  252.  
  253. TickFix  - Change the file name extension in *.TIC's from LZH or ARJ to ZIP.
  254.            For those who convert LZH & ARJ files to ZIP before tossing.
  255.  
  256. SHAMpage - Answer ALL SysOp pages - whether you're around or not.
  257.  
  258. ScrbNtfy - Notify players it is their move in one or more Scrabble door games
  259.            via a personal message addressed to them. Requires Postmstr.
  260.  
  261.